Skip to content

docs: bring command maps, references and how-tos up to date - #47

Merged
HaoZeke merged 1 commit into
mainfrom
fix/docs-drift
Nov 16, 2026
Merged

HaoZeke merged 1 commit into
mainfrom
fix/docs-drift

Conversation

@HaoZeke

@HaoZeke HaoZeke commented Nov 16, 2026

Copy link
Copy Markdown
Collaborator

The docs match the code again: command maps, the MCP list, line references, filter-deps and robot-tree guidance, the EESSI 2026.06 pins, a rustdoc link, and a doubled ///.

  • AGENTS.md lists package latest and stack capacity. The cli.org MCP list names eb_stack_footprints and eb_stack_admit. docs/campaign-boundary.md cites the current src/campaign.rs and src/foreign.rs lines and the run_target calls. The shard how-to says to plan with EESSI-extend's EASYBUILD_FILTER_DEPS, or pass that list as --filter-deps. The PyPI and CRAN how-tos say the robot tree is $EBROOTEASYBUILD/easybuild/easyconfigs from EESSI's EasyBuild module. The commented pins in the EESSI example policies name the EESSI 2026.06 bundles. The provides and campaign API docs have no broken link or stray ///.

The commit has a towncrier fragment. Main has no towncrier yet; #26 (fix/towncrier) adds it.

AGENTS.md left latest out of the package line and capacity out of the
stack line. The MCP list in cli.org skipped eb_stack_footprints and
eb_stack_admit, which mcp.rs registers and mcp.org lists.

docs/campaign-boundary.md cited src/campaign.rs and src/foreign.rs
lines from commit 1fd9fb5, up to 140 lines off now, and still named
request.target for the stage, build and verify calls that run_campaign
makes on run_target. Every reference was checked against the current
source. A staging failure is recorded as a Transport finding in place;
the preflight, build and verify call sites go through
record_target_command_failure.

The shard how-to never said that stack shard drops what --filter-deps
names and otherwise reads EASYBUILD_FILTER_DEPS. Planned outside
EESSI-extend, the compatibility-layer packages it filters count as
missing and the shared ones land in the prelude. The PyPI and CRAN
how-tos asked for the EESSI robot tree without saying where it is: the
easyconfigs bundled with EESSI's EasyBuild module, which holds the
2026.06 bundles. The commented pins in the two EESSI example policies
named 2025 bundles under a foss/2026.1 toolchain; they name
SciPy-bundle 2026.05, Python-bundle-PyPI 2026.04, R 4.6.1 and
R-bundle-CRAN 2026.07, the versions EESSI 2026.06 ships.

The provides module doc linked Candidate::EXT_PROVIDE_MARKER, which
does not exist, so cargo doc with -D rustdoc::broken-intra-doc-links
failed on it; the link now names the module's own EXT_PROVIDE_MARKER.
Two campaign doc comments carried a doubled ///.
@HaoZeke
HaoZeke merged commit 74bae83 into main Nov 16, 2026
21 checks passed
@HaoZeke
HaoZeke deleted the fix/docs-drift branch November 16, 2026 05:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant